<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>v_vscaler: V_vscaler_v1_0</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">v_vscaler
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a>  </div>
  <div class="headertitle">
<div class="title">V_vscaler_v1_0</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v__vscaler__l2.html">XV_vscaler_l2</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Hw Configuration</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpe07496529b2051c7e9395499f7cf4d41"></a>The following constants define the scaler HW MAX configuration</p>
</td></tr>
<tr class="memitem:ga25bd6db39119580782c05a374abe2e13"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__vscaler__v1__0.html#ga25bd6db39119580782c05a374abe2e13">XV_VScalerStart</a> (<a class="el" href="struct_x_v__vscaler.html">XV_vscaler</a> *InstancePtr)</td></tr>
<tr class="separator:ga25bd6db39119580782c05a374abe2e13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf3b903660b157f0898d07f30e030f596"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__vscaler__v1__0.html#gaf3b903660b157f0898d07f30e030f596">XV_VScalerStop</a> (<a class="el" href="struct_x_v__vscaler.html">XV_vscaler</a> *InstancePtr)</td></tr>
<tr class="separator:gaf3b903660b157f0898d07f30e030f596"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7bba843210fe656d54e7f79167c3ebba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__vscaler__v1__0.html#ga7bba843210fe656d54e7f79167c3ebba">XV_VScalerLoadExtCoeff</a> (<a class="el" href="struct_x_v__vscaler.html">XV_vscaler</a> *InstancePtr, <a class="el" href="struct_x_v__vscaler__l2.html">XV_vscaler_l2</a> *VscL2DataPtr, u16 num_phases, u16 num_taps, const short *Coeff)</td></tr>
<tr class="separator:ga7bba843210fe656d54e7f79167c3ebba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga866cba7665f1e97a66b0b8f0e6bc7081"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__vscaler__v1__0.html#ga866cba7665f1e97a66b0b8f0e6bc7081">XV_VScalerSetup</a> (<a class="el" href="struct_x_v__vscaler.html">XV_vscaler</a> *InstancePtr, <a class="el" href="struct_x_v__vscaler__l2.html">XV_vscaler_l2</a> *VscL2DataPtr, u32 WidthIn, u32 HeightIn, u32 HeightOut)</td></tr>
<tr class="separator:ga866cba7665f1e97a66b0b8f0e6bc7081"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa16c270d8cc6269835c33b3c610f1511"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__vscaler__v1__0.html#gaa16c270d8cc6269835c33b3c610f1511">XV_VScalerDbgReportStatus</a> (<a class="el" href="struct_x_v__vscaler.html">XV_vscaler</a> *InstancePtr)</td></tr>
<tr class="separator:gaa16c270d8cc6269835c33b3c610f1511"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gab89f0150cb75c41d7a6841ebcdd80d2d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__v__vscaler__v1__0.html#gab89f0150cb75c41d7a6841ebcdd80d2d">XV_VSCALER_TAPS</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__vscaler__l2_8h.html">xv_vscaler_l2.h</a>&gt;</code></p>

<p>This typedef enumerates the supported taps. </p>

</div>
</div>
<a class="anchor" id="ga634308cd79520f1e01e0efd5d0be4af7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__v__vscaler__v1__0.html#ga634308cd79520f1e01e0efd5d0be4af7">XV_VSCALER_TYPE</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__vscaler__l2_8h.html">xv_vscaler_l2.h</a>&gt;</code></p>

<p>This typedef eumerates the Scaler Type. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaa16c270d8cc6269835c33b3c610f1511"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_VScalerDbgReportStatus </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v__vscaler.html">XV_vscaler</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__vscaler__l2_8c.html">xv_vscaler_l2.c</a>&gt;</code></p>

<p>This function prints V Scaler status on the console. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the instance pointer to the core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_v__vscaler___config.html#a678c91d6ddbfadc7e80333f224a07be7">XV_vscaler_Config::BaseAddress</a>, <a class="el" href="struct_x_v__vscaler.html#a1622ea62ff6931a74737c9252f6cd7c1">XV_vscaler::Config</a>, <a class="el" href="struct_x_v__vscaler___config.html#a9c0520ce0ba587a6f02009e9d3ab5691">XV_vscaler_Config::NumTaps</a>, <a class="el" href="struct_x_v__vscaler___config.html#a84f5daf81cc174e2a20d3ea9a4ae057f">XV_vscaler_Config::PhaseShift</a>, and <a class="el" href="struct_x_v__vscaler___config.html#a070117f0c68f5258af73fa0e6017e1a2">XV_vscaler_Config::ScalerType</a>.</p>

</div>
</div>
<a class="anchor" id="ga7bba843210fe656d54e7f79167c3ebba"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_VScalerLoadExtCoeff </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v__vscaler.html">XV_vscaler</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_v__vscaler__l2.html">XV_vscaler_l2</a> *&#160;</td>
          <td class="paramname"><em>VscL2DataPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>num_phases</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>num_taps</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const short *&#160;</td>
          <td class="paramname"><em>Coeff</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__vscaler__l2_8c.html">xv_vscaler_l2.c</a>&gt;</code></p>

<p>This function loads user defined filter coefficients in the scaler coefficient storage. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on. </td></tr>
    <tr><td class="paramname">VscL2DataPtr</td><td>is a pointer to the core instance layer 2 data. </td></tr>
    <tr><td class="paramname">num_phases</td><td>is the number of phases in coefficient table </td></tr>
    <tr><td class="paramname">num_taps</td><td>is the number of taps in coefficient table </td></tr>
    <tr><td class="paramname">Coeff</td><td>is a pointer to user defined filter coefficients table</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_v__vscaler.html#a1622ea62ff6931a74737c9252f6cd7c1">XV_vscaler::Config</a>, and <a class="el" href="struct_x_v__vscaler___config.html#a84f5daf81cc174e2a20d3ea9a4ae057f">XV_vscaler_Config::PhaseShift</a>.</p>

</div>
</div>
<a class="anchor" id="ga866cba7665f1e97a66b0b8f0e6bc7081"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_VScalerSetup </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v__vscaler.html">XV_vscaler</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_v__vscaler__l2.html">XV_vscaler_l2</a> *&#160;</td>
          <td class="paramname"><em>VscL2DataPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>WidthIn</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>HeightIn</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>HeightOut</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__vscaler__l2_8c.html">xv_vscaler_l2.c</a>&gt;</code></p>

<p>This function configures the scaler core registers with the specified configuration parameters of the axi stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on. </td></tr>
    <tr><td class="paramname">WidthIn</td><td>is the input stream width </td></tr>
    <tr><td class="paramname">HeightIn</td><td>is the input stream height </td></tr>
    <tr><td class="paramname">HeightOut</td><td>is the output stream height</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_v__vscaler.html#a1622ea62ff6931a74737c9252f6cd7c1">XV_vscaler::Config</a>, <a class="el" href="struct_x_v__vscaler___config.html#a4d7efc84f5dd8b881fcc5180065a9207">XV_vscaler_Config::PixPerClk</a>, and <a class="el" href="struct_x_v__vscaler___config.html#a070117f0c68f5258af73fa0e6017e1a2">XV_vscaler_Config::ScalerType</a>.</p>

</div>
</div>
<a class="anchor" id="ga25bd6db39119580782c05a374abe2e13"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_VScalerStart </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v__vscaler.html">XV_vscaler</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__vscaler__l2_8c.html">xv_vscaler_l2.c</a>&gt;</code></p>

<p>This function starts the vertical scaler core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
<a class="anchor" id="gaf3b903660b157f0898d07f30e030f596"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_VScalerStop </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v__vscaler.html">XV_vscaler</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__vscaler__l2_8c.html">xv_vscaler_l2.c</a>&gt;</code></p>

<p>This function stops the vertical scaler core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
</div><!-- contents -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
